[Feature][Java/Spring] Support Discriminator Based OneOf Interface #11650

cachescrubber · 2022-02-18T05:30:47Z

Support Discriminator Based OneOf Interface

Superseeds

[Spring][server] oneOf Interface for Spring Boot #10392, which is in turn based on
[Spring][server] oneOf Interface for Spring Boot #8091

Also Fixes

[REQ][spring] Feature x-implements is not supported #11636

Brings basic discriminator based OneOf Support to the JavaSpring generator. It generates a marker Interface which the oneOf Models then implement. Technically it requires Jackson based models and is implemented using @JsonTypeInfo and @JsonSubTypes based using a discriminator property.

The relevant Code ist moved to AbstractJavaCodegen and aligned with the other Java based generators in the hierarchy.

The oneOf Support is implemented by utilizing the x-implements vendor extension.

Currently It is enabled in the SpringCodegen only:

useOneOfInterfaces = true;
legacyDiscriminatorBehavior = false;

Synopsis

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.EXISTING_PROPERTY, property = "@type", visible = true)
@JsonSubTypes({
  @JsonSubTypes.Type(value = Foo.class, name = "Foo"),
  @JsonSubTypes.Type(value = FooRef.class, name = "FooRef")
})

@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
public interface FooRefOrValue {
    public String getAtType();
}

PR checklist

[ x] Read the contribution guidelines.
[ x] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
[x ] Run the following to build the project and update samples:
```
./mvnw clean package 
./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh
```
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
For Windows users, please run the script in Git BASH.
[ x] File the PR against the correct branch: master (5.3.0), 6.0.x
[ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

added x-is-one-of-interface extension for oneOf interface in mustache template

fixed name of model from UNKNOWN_BASE_TYPE to right one in api: operationId + OneOf Fix OpenAPITools#5381 parcelableModel is not required

removed not needed methods

catch NPE cases in preprocessOpenAPI updated samples

…rator into spring_fix_5381

fixed generation of oneOf Models

addOneOfInterfaceModel only for cases when useOneOfInterfaces is true and for spring

NPE fix

…rator into spring_fix_5381

…rator into spring_fix_5381 � Conflicts: � modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

spring: fixed use of oneOf Models in API

implementing oneOf for spring lib overriding methods with different behavior from default

added x-is-one-of-interface extension for oneOf interface in mustache template

fixed name of model from UNKNOWN_BASE_TYPE to right one in api: operationId + OneOf Fix OpenAPITools#5381 removed not needed methods Fix OpenAPITools#5381 fixed generation of oneOf Models Fix OpenAPITools#5381 addOneOfInterfaceModel only for cases when useOneOfInterfaces is true and for spring Fix OpenAPITools#5381 NPE fix for tests

fixed handing of composed schema with array

fixed NPE in addOneOfInterfaceModel

fixed generation of oneOf models with descriminator

# Conflicts: # modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

# Conflicts: # modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

# Conflicts: # modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java # modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

…api-generator into jburgess-spring_fix_5381_jb

# Conflicts: # modules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache # modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

cachescrubber · 2022-02-23T19:47:03Z

...enapi3/server/petstore/spring-boot-oneof/src/main/java/org/openapitools/model/EntityRef.java

+
+@Schema(name = "EntityRef", description = "Entity reference schema to be use for all entityRef class.")
+@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.EXISTING_PROPERTY, property = "@type", visible = true)
+@JsonSubTypes({


Example for inheritance using discriminator

cachescrubber · 2022-02-23T19:48:32Z

.../openapi3/server/petstore/spring-boot-oneof/src/main/java/org/openapitools/model/FooRef.java

+
+
+@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
+public class FooRef extends EntityRef implements FooRefOrValue {


Example: Inherit from EntityRef class using discriminator an implementing the oneOf Interface.

cachescrubber · 2022-02-23T19:48:53Z

...i3/server/petstore/spring-boot-oneof/src/main/java/org/openapitools/model/FooRefOrValue.java

+})
+
+@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
+public interface FooRefOrValue {


The OneOf Interface

welshm

Makes sense overall - I do wonder how nested oneOf will work

...es/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java

modules/openapi-generator/src/test/resources/3_0/issue_5381.yaml

jburgess · 2022-03-01T02:13:13Z

@cachescrubber Thank you so much for picking this up and keeping it up-to-date with the base branch! Initial testing looks good on this PR.

@wing328 Can we get this in a milestone?

… (Bar_Create)

# Conflicts: # modules/openapi-generator/src/main/resources/JavaSpring/typeInfoAnnotation.mustache

welshm · 2022-03-07T14:50:21Z

modules/openapi-generator/src/main/resources/JavaSpring/model.mustache

@@ -46,7 +46,7 @@ import javax.annotation.Generated;
 {{>enumOuterClass}}
 {{/isEnum}}
 {{^isEnum}}
-{{>pojo}}
+{{#vendorExtensions.x-is-one-of-interface}}{{>oneof_interface}}{{/vendorExtensions.x-is-one-of-interface}}{{^vendorExtensions.x-is-one-of-interface}}{{>pojo}}{{/vendorExtensions.x-is-one-of-interface}}


Is this still necessary after #11784 ?

Yes, very much so. It the model entity is a one-of-interface, a public interface MyModel is generated instead of a public class myModel. Or do I miss something?

wing328 · 2022-03-08T16:24:14Z

@cachescrubber thanks for the PR. Here are something we discussed before and put it here so that everyone is on the same page:

implementation by this PR does not support primitive type, e.g.

    IntOrString:
      oneOf:
        - type: string
        - type: integer

oneOf does not imply inheritance

# Conflicts: # modules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache

wing328 · 2022-03-16T14:49:07Z

Also just to add that java (okhttp-gson, jersey2, native) client generator has a different implementation of oneOf, anyOf.

We can give this PR (implementation) a try and collect feedback from our users.

cachescrubber · 2022-03-16T17:23:50Z

@wing328. Thanks for the review and merging!

alexsuperdev and others added 30 commits March 22, 2020 11:15

Fix OpenAPITools#5381

6a8769e

added x-is-one-of-interface extension for oneOf interface in mustache template

Fix OpenAPITools#5381

049359c

fixed name of model from UNKNOWN_BASE_TYPE to right one in api: operationId + OneOf Fix OpenAPITools#5381 parcelableModel is not required

Fix OpenAPITools#5381

49f13eb

removed not needed methods

Fix OpenAPITools#5381

1a5a484

catch NPE cases in preprocessOpenAPI updated samples

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

66a09d2

…rator into spring_fix_5381

Fix OpenAPITools#5381

48a1a4a

fixed generation of oneOf Models

Fix OpenAPITools#5381

a811330

addOneOfInterfaceModel only for cases when useOneOfInterfaces is true and for spring

Fix OpenAPITools#5381

299cdb3

NPE fix

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

461cbc8

…rator into spring_fix_5381

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

dd0118d

…rator into spring_fix_5381 � Conflicts: � modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

Fix OpenAPITools#5381

26a95f6

spring: fixed use of oneOf Models in API

Fix OpenAPITools#5381

9af7db6

implementing oneOf for spring lib overriding methods with different behavior from default

Fix OpenAPITools#5381

fbfd57d

added x-is-one-of-interface extension for oneOf interface in mustache template

Fix OpenAPITools#5381

29003d8

fixed handing of composed schema with array

Fix OpenAPITools#5381

d864831

fixed NPE in addOneOfInterfaceModel

Fix OpenAPITools#5381

6d54799

fixed generation of oneOf models with descriminator

Merge remote-tracking branch 'super/master' into spring_fix_5381_jb

c6a5c6b

# Conflicts: # modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

Merge remote-tracking branch 'super/master' into spring_fix_5381_jb

d96cd2e

Initial merge of 5.0

8f09f52

Aligned with master formatting

0d31df4

Corrected spacing for class names to align with samples.

397e711

Merge remote-tracking branch 'source/master' into spring_fix_5381_jb

a922217

# Conflicts: # modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

Merge remote-tracking branch 'source/master' into spring_fix_5381_jb

21a98e5

Merge remote-tracking branch 'source/master' into spring_fix_5381_jb

1b5964e

# Conflicts: # modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java # modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

Merged master

05105fa

Updated samples

c89a28b

Merge branch 'spring_fix_5381_jb' of https://github.com/jburgess/open…

4808e87

…api-generator into jburgess-spring_fix_5381_jb

Merge branch 'master' into jburgess-spring_fix_5381_jb

03a6210

# Conflicts: # modules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache # modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

Merge branch 'master' into jburgess-spring_fix_5381_jb

7db40af

Generate Samples

58bd55b

cachescrubber commented Feb 23, 2022

View reviewed changes

welshm reviewed Feb 24, 2022

View reviewed changes

...es/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java Outdated Show resolved Hide resolved

modules/openapi-generator/src/test/resources/3_0/issue_5381.yaml Show resolved Hide resolved

Merge branch 'master' into feature/java_spring_oneof_discriminator_basic

af28bbe

cachescrubber added 5 commits March 1, 2022 06:05

Merge branch 'master' into feature/java_spring_oneof_discriminator_basic

d6558a8

Giv example oas spec a meaningful name, demo usage of oneOf in Model

d03f748

Generate Samples

b345151

Remove unnecessary JsonTypeName include, add example for JsonTypeName…

f8b70a8

… (Bar_Create)

Generate Samples

c161329

cachescrubber mentioned this pull request Mar 6, 2022

[Java] support x-implements #11784

Merged

5 tasks

cachescrubber and others added 4 commits March 6, 2022 16:10

Merge branch 'master' into feature/java_spring_oneof_discriminator_basic

833893a

Merge branch 'master' into feature/java_spring_oneof_discriminator_basic

6e01140

Merge branch 'master' into feature/java_spring_oneof_discriminator_basic

d43692e

# Conflicts: # modules/openapi-generator/src/main/resources/JavaSpring/typeInfoAnnotation.mustache

Generate Samples

deeb394

welshm reviewed Mar 7, 2022

View reviewed changes

Merge branch 'master' into feature/java_spring_oneof_discriminator_basic

e619e73

# Conflicts: # modules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache

wing328 added this to the 6.0.0 milestone Mar 16, 2022

wing328 merged commit e07c7d1 into OpenAPITools:master Mar 16, 2022

This was referenced Mar 16, 2022

[Spring][server] oneOf Interface for Spring Boot #10392

Closed

[Spring][server] oneOf Interface for Spring Boot #8091

Closed

wagnerrobsan mentioned this pull request Mar 21, 2022

[BUG] [Spring] [Java] Invalid code generated for schemas with oneOf object attributes #11932

Closed

6 tasks

LubomirS mentioned this pull request Jun 24, 2022

[BUG] [SPRING] legacyDiscriminatorBehavior property is always ignored #12692

Closed

6 tasks

welshm mentioned this pull request Jan 2, 2023

[spring] oneOf implementation for spring boot #10993

Open

5 tasks

alexsuperdev mentioned this pull request Jan 26, 2024

[Spring][server] oneOf Polymorphism support for spring boot #5661

Open

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Feature][Java/Spring] Support Discriminator Based OneOf Interface #11650

[Feature][Java/Spring] Support Discriminator Based OneOf Interface #11650

cachescrubber commented Feb 18, 2022 •

edited

Loading

cachescrubber Feb 23, 2022

cachescrubber Feb 23, 2022

cachescrubber Feb 23, 2022

welshm left a comment

jburgess commented Mar 1, 2022

welshm Mar 7, 2022

cachescrubber Mar 8, 2022

wing328 commented Mar 8, 2022

wing328 commented Mar 16, 2022

cachescrubber commented Mar 16, 2022



		@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
		public class FooRef extends EntityRef implements FooRefOrValue {

[Feature][Java/Spring] Support Discriminator Based OneOf Interface #11650

[Feature][Java/Spring] Support Discriminator Based OneOf Interface #11650

Conversation

cachescrubber commented Feb 18, 2022 • edited Loading

Support Discriminator Based OneOf Interface

Synopsis

PR checklist

cachescrubber Feb 23, 2022

Choose a reason for hiding this comment

cachescrubber Feb 23, 2022

Choose a reason for hiding this comment

cachescrubber Feb 23, 2022

Choose a reason for hiding this comment

welshm left a comment

Choose a reason for hiding this comment

jburgess commented Mar 1, 2022

welshm Mar 7, 2022

Choose a reason for hiding this comment

cachescrubber Mar 8, 2022

Choose a reason for hiding this comment

wing328 commented Mar 8, 2022

wing328 commented Mar 16, 2022

cachescrubber commented Mar 16, 2022

cachescrubber commented Feb 18, 2022 •

edited

Loading